/*
* INSANE - Interactive Structural Analysis Environment
*
* Copyright (C) 2003-2005
* Universidade Federal de Minas Gerais
* Escola de Engenharia
* Departamento de Engenharia de Estruturas
* 
* Author's email :    insane@dees.ufmg.br
* Author's website :  http://www.dees.ufmg.br/insane
* 
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or any later version.
* 
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
* 
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
package br.ufmg.dees.insane.solution;

import java.util.Observer;

import br.ufmg.dees.insane.assembler.Assembler;
import br.ufmg.dees.insane.util.IVector;
import br.ufmg.dees.insane.util.LinearEquationSystems;

/** 
 * A class defining a
 *
 * @author Fuina, Jamile & Pitangueira, Roque
 * @since March 2005
 */
public interface Step{
	    
	public IVector getXP();
    
	public int 	getCurrentIteration();
    
    public int getNumMaxIterations();
    
	public void setNumMaxIterations(int numMI);
    
	public IVector getUnbalancedX();
    
	public void assignStepState(double lambda);
    
	public boolean getConvergence();
    
	public void setConvergence();
    
    public double getTolerance();
    
    public double getCurrentError();
    
    public void setTolerance(double tol);
    
    public void execute();
    
    public void setIteractiveStrategy(IteractiveStrategy itestr);
    
    public IteractiveStrategy getIteractiveStrategy( );
    
    public void setAssembler(Assembler ass);
    
    public Assembler getAssembler( );
    
    public IVector getProportionalLoad();
    
    public IVector getConstantLoad();
    
    public int getLabel();
    
    /**
     * @return Load Factor 
     */
    public abstract double getLoadFactorTotal();
    /**
     * @return Load Factor 
     */
    public abstract void setLoadFactorTotal(double totalLoadFactor);
    
    public LinearEquationSystems getSel( );
    
    /**
     * @param lb the label of the step
     */
    public void setLabel(int lb);
    
    /**
     * @return Returns the convType.
     */
    public byte getConvType();
    
    /**
     * @param convType The convType to set.
     */
    public void setConvType(byte convType);
    
    /**
	 * @return Returns the initialLoadFactor.
	 */
	public double getInitialLoadFactor(); 
	
	/**
	 * @param initialLoadFactor The initialLoadFactor to set.
	 */
	public void setInitialLoadFactor(double initialLoadFactor);
    
    /* (non-Javadoc)
     * @see java.util.Observable#addObserver(java.util.Observer)
     */
    public abstract void addObserver(Observer arg0);
}
